fix: make StepRegistry atomic and raise on corruption - #3922
Open
Quratulain-bilal wants to merge 1 commit into
Open
fix: make StepRegistry atomic and raise on corruption#3922Quratulain-bilal wants to merge 1 commit into
Quratulain-bilal wants to merge 1 commit into
Conversation
…nt data loss 1. _load() now raises OSError on symlinked paths and corrupted files instead of silently returning empty defaults (matches WorkflowRegistry) 2. save() now writes to a temp file and atomically replaces, preventing data loss from truncated writes on crash
Contributor
There was a problem hiding this comment.
Pull request overview
Makes StepRegistry fail closed on corruption and persist data atomically.
Changes:
- Raises
OSErrorfor unsafe or corrupted registries. - Writes through a temporary file using
os.replace. - Cleans up temporary files after failures.
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/workflows/catalog.py |
Hardens registry loading and saving. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 3
- Review effort level: Balanced
Comment on lines
+901
to
+908
| except ( | ||
| json.JSONDecodeError, | ||
| ValueError, | ||
| UnicodeError, | ||
| ) as exc: | ||
| raise OSError( | ||
| f"Step registry at {self.registry_path} is corrupted: {exc}" | ||
| ) from exc |
Comment on lines
+942
to
+944
| with os.fdopen(fd, "w", encoding="utf-8") as f: | ||
| json.dump(self.data, f, indent=2) | ||
| os.replace(tmp, self.registry_path) |
Comment on lines
+889
to
+892
| raise OSError( | ||
| f"Refusing to read step registry at {self.registry_path}: " | ||
| "a parent directory or the registry file itself is a symlink" | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
StepRegistry._load()silently returned empty defaults on corruption, causing installed steps to appear to vanish.save()wrote directly to the target file risking data loss.Fix
_load()now raisesOSErroron symlinked paths and corrupted files.save()now uses atomic writes via mkstemp + os.replace.